Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix 5747 rendering util types #5798

Merged
merged 10 commits into from
Sep 8, 2024

Conversation

bollwyvl
Copy link
Contributor

📑 Summary

This removes the .d from mermaid/rendering-util/types[.d].ts, and updates the syntax to make it a valid TypeScript file so that it would end up in dist/rendering-util/types.d.ts.

Starts #5747 (haven't yet looked into the $root mangling)

📏 Design Decisions

This highlighted some type issues in the elk renderer where java-style dotted properties had been replaced with nested definitions in the MermaidConfig schema.

Additionally, to pass lint, this adds another generated file to the eslint ignore due to its "abusive" blanket eslint ignore comment.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Aug 30, 2024

⚠️ No Changeset found

Latest commit: 35c0898

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Aug 30, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 35c0898
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/66dda5b160114e00087fcf31
😎 Deploy Preview https://deploy-preview-5798--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Aug 30, 2024

Codecov Report

Attention: Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.

Project coverage is 5.01%. Comparing base (58524ac) to head (35c0898).
Report is 21 commits behind head on develop.

Files with missing lines Patch % Lines
packages/mermaid-layout-elk/src/render.ts 0.00% 6 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #5798   +/-   ##
=======================================
  Coverage     5.01%   5.01%           
=======================================
  Files          336     336           
  Lines        48073   48073           
  Branches       575     575           
=======================================
  Hits          2413    2413           
  Misses       45660   45660           
Flag Coverage Δ
unit 5.01% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
packages/mermaid-layout-elk/src/render.ts 0.00% <0.00%> (ø)

Copy link

argos-ci bot commented Aug 30, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Sep 8, 2024, 1:37 PM

@bollwyvl
Copy link
Contributor Author

bollwyvl commented Sep 1, 2024

#5805 expands on this, and would fully resolve #5747.

Copy link

pkg-pr-new bot commented Sep 8, 2024

Open in Stackblitz

pnpm add https://pkg.pr.new/mermaid-js/mermaid@5798
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@5798
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@5798
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@5798

commit: 35c0898

@sidharthv96 sidharthv96 added this pull request to the merge queue Sep 8, 2024
Merged via the queue into mermaid-js:develop with commit e5aebf3 Sep 8, 2024
21 checks passed
@bollwyvl bollwyvl deleted the gh-5747-rendering-util-types branch September 8, 2024 17:03
@bollwyvl
Copy link
Contributor Author

bollwyvl commented Sep 8, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants